<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_hdmitx: XV_HdmiTx_Stream Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_hdmitx
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_v___hdmi_tx___stream.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XV_HdmiTx_Stream Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This typedef contains HDMI TX stream specific data structure.  
 <a href="struct_x_v___hdmi_tx___stream.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aed13920c568f0a6101fe97e5a0ce981a"><td class="memItemLeft" align="right" valign="top">XVidC_VideoStream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#aed13920c568f0a6101fe97e5a0ce981a">Video</a></td></tr>
<tr class="memdesc:aed13920c568f0a6101fe97e5a0ce981a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Video stream for HDMI TX.  <a href="#aed13920c568f0a6101fe97e5a0ce981a">More...</a><br/></td></tr>
<tr class="separator:aed13920c568f0a6101fe97e5a0ce981a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5002600fe2e2dbd7286162bb500941d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_v___hdmi_tx___audio_stream.html">XV_HdmiTx_AudioStream</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#af5002600fe2e2dbd7286162bb500941d">Audio</a></td></tr>
<tr class="memdesc:af5002600fe2e2dbd7286162bb500941d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Audio stream for HDMI TX.  <a href="#af5002600fe2e2dbd7286162bb500941d">More...</a><br/></td></tr>
<tr class="separator:af5002600fe2e2dbd7286162bb500941d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3d63314205b73121885a6da80cfe7cf"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#ab3d63314205b73121885a6da80cfe7cf">Vic</a></td></tr>
<tr class="memdesc:ab3d63314205b73121885a6da80cfe7cf"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment"> Video Identification code
</pre><p> flag  <a href="#ab3d63314205b73121885a6da80cfe7cf">More...</a><br/></td></tr>
<tr class="separator:ab3d63314205b73121885a6da80cfe7cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a094b972b5add25f8189946125ee5de37"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#a094b972b5add25f8189946125ee5de37">IsHdmi</a></td></tr>
<tr class="memdesc:a094b972b5add25f8189946125ee5de37"><td class="mdescLeft">&#160;</td><td class="mdescRight">HDMI flag.  <a href="#a094b972b5add25f8189946125ee5de37">More...</a><br/></td></tr>
<tr class="separator:a094b972b5add25f8189946125ee5de37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff6cb4519db331ab7336ae75c2cc56b8"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#aff6cb4519db331ab7336ae75c2cc56b8">IsHdmi20</a></td></tr>
<tr class="memdesc:aff6cb4519db331ab7336ae75c2cc56b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">HDMI 2.0 flag.  <a href="#aff6cb4519db331ab7336ae75c2cc56b8">More...</a><br/></td></tr>
<tr class="separator:aff6cb4519db331ab7336ae75c2cc56b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9ca6e199b3a6729a3a0db9cb6e43bbd"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#ae9ca6e199b3a6729a3a0db9cb6e43bbd">IsScrambled</a></td></tr>
<tr class="memdesc:ae9ca6e199b3a6729a3a0db9cb6e43bbd"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">                 Scrambler flag
</pre><p> 1 - scrambled data , 0 - non scrambled data  <a href="#ae9ca6e199b3a6729a3a0db9cb6e43bbd">More...</a><br/></td></tr>
<tr class="separator:ae9ca6e199b3a6729a3a0db9cb6e43bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f7391ec51828911287f12c706f48065"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#a0f7391ec51828911287f12c706f48065">OverrideScrambler</a></td></tr>
<tr class="memdesc:a0f7391ec51828911287f12c706f48065"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override scramble flag.  <a href="#a0f7391ec51828911287f12c706f48065">More...</a><br/></td></tr>
<tr class="separator:a0f7391ec51828911287f12c706f48065"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a498466feabb81f3368b723a8104159d0"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#a498466feabb81f3368b723a8104159d0">TMDSClock</a></td></tr>
<tr class="memdesc:a498466feabb81f3368b723a8104159d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">TMDS clock.  <a href="#a498466feabb81f3368b723a8104159d0">More...</a><br/></td></tr>
<tr class="separator:a498466feabb81f3368b723a8104159d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a32c654d0ab9b88f4d19c4985fae1f6"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#a2a32c654d0ab9b88f4d19c4985fae1f6">TMDSClockRatio</a></td></tr>
<tr class="memdesc:a2a32c654d0ab9b88f4d19c4985fae1f6"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">                 TMDS clock ration
</pre><p> 0 - 1/10, 1 - 1/40  <a href="#a2a32c654d0ab9b88f4d19c4985fae1f6">More...</a><br/></td></tr>
<tr class="separator:a2a32c654d0ab9b88f4d19c4985fae1f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac40b3c4cd28b83852edc439caf9f7a44"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#ac40b3c4cd28b83852edc439caf9f7a44">PixelClk</a></td></tr>
<tr class="memdesc:ac40b3c4cd28b83852edc439caf9f7a44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pixel Clock.  <a href="#ac40b3c4cd28b83852edc439caf9f7a44">More...</a><br/></td></tr>
<tr class="separator:ac40b3c4cd28b83852edc439caf9f7a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a577d0e96c465c57b4ea25523a5186188"><td class="memItemLeft" align="right" valign="top">XV_HdmiTx_State&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#a577d0e96c465c57b4ea25523a5186188">State</a></td></tr>
<tr class="memdesc:a577d0e96c465c57b4ea25523a5186188"><td class="mdescLeft">&#160;</td><td class="mdescRight">State.  <a href="#a577d0e96c465c57b4ea25523a5186188">More...</a><br/></td></tr>
<tr class="separator:a577d0e96c465c57b4ea25523a5186188"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4239c08cfef43b6efe597fdb6c501c8d"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#a4239c08cfef43b6efe597fdb6c501c8d">IsConnected</a></td></tr>
<tr class="memdesc:a4239c08cfef43b6efe597fdb6c501c8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connected flag.  <a href="#a4239c08cfef43b6efe597fdb6c501c8d">More...</a><br/></td></tr>
<tr class="separator:a4239c08cfef43b6efe597fdb6c501c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac287f6a3125047a10f32e6ca8b7a58eb"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hdmi_tx___stream.html#ac287f6a3125047a10f32e6ca8b7a58eb">SampleRate</a></td></tr>
<tr class="memdesc:ac287f6a3125047a10f32e6ca8b7a58eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sample rate.  <a href="#ac287f6a3125047a10f32e6ca8b7a58eb">More...</a><br/></td></tr>
<tr class="separator:ac287f6a3125047a10f32e6ca8b7a58eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This typedef contains HDMI TX stream specific data structure. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="af5002600fe2e2dbd7286162bb500941d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_v___hdmi_tx___audio_stream.html">XV_HdmiTx_AudioStream</a> XV_HdmiTx_Stream::Audio</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Audio stream for HDMI TX. </p>

</div>
</div>
<a class="anchor" id="a4239c08cfef43b6efe597fdb6c501c8d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XV_HdmiTx_Stream::IsConnected</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Connected flag. </p>
<p>This flag is set when the cable is connected </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#acfeb8c295991a88031817404dd4135f3">XV_HdmiTx_CfgInitialize()</a>, and <a class="el" href="xv__hdmitx_8h.html#a7380f59f3609455c91e7090b7fde1504">XV_HdmiTx_IsStreamConnected()</a>.</p>

</div>
</div>
<a class="anchor" id="a094b972b5add25f8189946125ee5de37"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XV_HdmiTx_Stream::IsHdmi</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>HDMI flag. </p>
<p>1 - HDMI Stream, 0 - DVI Stream </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#a6dc5aa725b963236382283b2c4810dc1">XV_HdmiTx_SetDviMode()</a>, and <a class="el" href="xv__hdmitx_8h.html#ab5d2bcd25ed4a775b87e716ad8d2a8d6">XV_HdmiTx_SetHdmiMode()</a>.</p>

</div>
</div>
<a class="anchor" id="aff6cb4519db331ab7336ae75c2cc56b8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XV_HdmiTx_Stream::IsHdmi20</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>HDMI 2.0 flag. </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#a18857793bd92eafef197b339cf1f956e">XV_HdmiTx_ClockRatio()</a>, <a class="el" href="xv__hdmitx_8h.html#afe6f171ef3d393c4653b17837c5a105a">XV_HdmiTx_DetectHdmi20()</a>, <a class="el" href="xv__hdmitx_8h.html#a588fe097262642349aa193a0665ff81f">XV_HdmiTx_Scrambler()</a>, and <a class="el" href="xv__hdmitx_8h.html#ae42733f7ec1fcf5df4f6d537b588bab6">XV_HdmiTx_SetStream()</a>.</p>

</div>
</div>
<a class="anchor" id="ae9ca6e199b3a6729a3a0db9cb6e43bbd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XV_HdmiTx_Stream::IsScrambled</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">                 Scrambler flag
</pre><p> 1 - scrambled data , 0 - non scrambled data </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#aa1b9824b19f5af7b841f52d797a3b0fc">XV_HdmiTx_IsStreamScrambled()</a>, <a class="el" href="xv__hdmitx_8h.html#a588fe097262642349aa193a0665ff81f">XV_HdmiTx_Scrambler()</a>, and <a class="el" href="xv__hdmitx_8h.html#ae42733f7ec1fcf5df4f6d537b588bab6">XV_HdmiTx_SetStream()</a>.</p>

</div>
</div>
<a class="anchor" id="a0f7391ec51828911287f12c706f48065"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XV_HdmiTx_Stream::OverrideScrambler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Override scramble flag. </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#acfeb8c295991a88031817404dd4135f3">XV_HdmiTx_CfgInitialize()</a>, and <a class="el" href="xv__hdmitx_8h.html#a588fe097262642349aa193a0665ff81f">XV_HdmiTx_Scrambler()</a>.</p>

</div>
</div>
<a class="anchor" id="ac40b3c4cd28b83852edc439caf9f7a44"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XV_HdmiTx_Stream::PixelClk</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pixel Clock. </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#a8f0f03c92ab4f206b0a8e0d3c7a6c502">XV_HdmiTx_GetTmdsClk()</a>.</p>

</div>
</div>
<a class="anchor" id="ac287f6a3125047a10f32e6ca8b7a58eb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XV_HdmiTx_Stream::SampleRate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sample rate. </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#abb0cde0fed5637779f430ca6eb2a9199">XV_HdmiTx_SetSampleRate()</a>.</p>

</div>
</div>
<a class="anchor" id="a577d0e96c465c57b4ea25523a5186188"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XV_HdmiTx_State XV_HdmiTx_Stream::State</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>State. </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#acfeb8c295991a88031817404dd4135f3">XV_HdmiTx_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a498466feabb81f3368b723a8104159d0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XV_HdmiTx_Stream::TMDSClock</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>TMDS clock. </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#a588fe097262642349aa193a0665ff81f">XV_HdmiTx_Scrambler()</a>, and <a class="el" href="xv__hdmitx_8h.html#ae42733f7ec1fcf5df4f6d537b588bab6">XV_HdmiTx_SetStream()</a>.</p>

</div>
</div>
<a class="anchor" id="a2a32c654d0ab9b88f4d19c4985fae1f6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XV_HdmiTx_Stream::TMDSClockRatio</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">                 TMDS clock ration
</pre><p> 0 - 1/10, 1 - 1/40 </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#a18857793bd92eafef197b339cf1f956e">XV_HdmiTx_ClockRatio()</a>, and <a class="el" href="xv__hdmitx_8h.html#ae42733f7ec1fcf5df4f6d537b588bab6">XV_HdmiTx_SetStream()</a>.</p>

</div>
</div>
<a class="anchor" id="ab3d63314205b73121885a6da80cfe7cf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XV_HdmiTx_Stream::Vic</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment"> Video Identification code
</pre><p> flag </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#ae42733f7ec1fcf5df4f6d537b588bab6">XV_HdmiTx_SetStream()</a>.</p>

</div>
</div>
<a class="anchor" id="aed13920c568f0a6101fe97e5a0ce981a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_VideoStream XV_HdmiTx_Stream::Video</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Video stream for HDMI TX. </p>

<p>Referenced by <a class="el" href="xv__hdmitx_8h.html#a0b2224de9eedafa13c184cb0d680f891">XV_HdmiTx_DebugInfo()</a>, <a class="el" href="xv__hdmitx_8h.html#a9271b92c3193e1ce46a2b610080c6f06">XV_HdmiTx_SetColorDepth()</a>, <a class="el" href="xv__hdmitx_8h.html#aa8eb6378fdb4a48a22fdedb89cc3702a">XV_HdmiTx_SetColorFormat()</a>, <a class="el" href="xv__hdmitx_8h.html#abe6e4feed643a46f8c5a09494d2e2874">XV_HdmiTx_SetPixelRate()</a>, and <a class="el" href="xv__hdmitx_8h.html#ae42733f7ec1fcf5df4f6d537b588bab6">XV_HdmiTx_SetStream()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
